Add indexer and str to API documentation #5124

jankatins · 2013-10-06T16:58:05Z

jtratner · 2013-10-06T17:54:19Z

doc/make.py

@@ -72,7 +72,12 @@ def upload_prev(ver, doc_root='./'):
    if os.system(pdf_cmd):
        raise SystemExit('Upload PDF to %s from %s failed' % (ver, doc_root))

-
+def build_pandas():


this is covered by make doc already.

I'm on windows :-) And it doesn't seem to be in the makefile (at least make doc has no compile step)

does this make it trigger on any attempt to build?

Not that I know. I simple tried to get the doc build working (cd doc; python make.py html -> error) and had to C&P from the build_prev function to the commandline and was fed up after the second time :-) Now its cd doc; python make.py build_pandas; python make.py html

as long as this doesn't cause doc builds to wipe and rebuild pandas, it's fine with me.

jtratner · 2013-10-06T17:55:50Z

Seems like a reasonable (and time-efficient) way to at least document the API.

jtratner · 2013-10-06T18:19:23Z

really minor note, can you fix the typo in your commit message: convinience --> convenience? Not a big deal, just would be nice.

jankatins · 2013-10-06T18:21:57Z

done

jtratner · 2013-10-06T20:09:06Z

Example docs - http://jtratner.github.io/example-pandas-docs/series-str-2013-10-6/

jorisvandenbossche · 2013-10-06T20:44:50Z

doc/source/api.rst

@@ -419,8 +425,46 @@ Time series-related
   Series.tz_convert
   Series.tz_localize

+String handling
+~~~~~~~~~~~~~~~~~~~
+``Series.str`` can be used to access the values of the series as strings and apply several methods to it. Due to implementation details the methods show up here as methods of the ``StringMethods`` class.


Can we stick to the 79 chars line length? (or at least to 99 chars) Because now it is difficult to read in the source code (for example on github, it doesn't fit on my screen).
Is there a convention in pandas to follow or not follow pep8 on this?

if you're adding something new to the docs, generally should keep to 79 characters

jorisvandenbossche · 2013-10-06T21:03:25Z

@JanSchulz It is always good to add more docs to the api docs! (there are still missing a lot).

Regarding building the (api) docs on windows, I have the same problem with the io.rst. I always remove that part in io.rst when developing/building the docs locally .. (which is a little bit annoying).

jreback · 2013-10-07T00:16:42Z

@JanSchulz while you are adding....can you put in to_timedelta ? (next to to_datetime)

jankatins · 2013-10-07T20:25:19Z

Wow, there is quite a lot of API documentation missing:
http://nbviewer.ipython.org/urls/gist.github.com/JanSchulz/6874142/raw/f6d2a5472a0b1369bd112701913da83ab6827f21/pandas_api.ipynb

jreback · 2013-10-07T20:36:18Z

you seem to be double counting the undocumented, e.g. read_csv shows up in your list, but is documented

jankatins · 2013-10-07T20:55:34Z

@jreback That's because the API documentation refers to the context pandas.io.parsers, so the imported pandas.read_csv is marked as undocumented.

jankatins · 2013-10-07T20:57:55Z

@jreback: to_timedelta added

@jorisvandenbossche, @jtratner: shortend the lines

Sorry for the rebase mess :-( Not sure how to convince github that the PR now starts at a different commit :-(

jtratner · 2013-10-07T21:33:10Z

force push the branch.

Also, just a heads up, some of the methods you point out are quasi-internal (like is_) or experimental-ish. Maybe you could put them all in the wiki and we can collectively work to document them, then combine into one big PR?

jankatins · 2013-10-07T22:20:41Z

@jreback re double counting: I removed more or less all context from api.rst (which resulted in only two errors: one for Stata*: #5144 and one for sql read_frame/ write_frame). The resulting count: public methods: 983; documented: 503, undocumented: 522

@jtratner done: https://github.com/pydata/pandas/wiki/Undocumented-public-functions

I also updated the ipynb to the version I used to generate this data (you also must change api.rst so that all context point directly to pandas and not to modules like pandas.io.sql)

jtratner · 2013-10-07T22:55:39Z

can you do that for the rest of the pandas docs?

jorisvandenbossche · 2013-10-08T07:31:11Z

See also #4790. If eg DataFrame is included in the docs, the docstring of all methods will automatically be linked to (at least from the DataFrame docstring).

jreback · 2013-10-11T12:00:02Z

@JanSchulz pls rebase on master

jreback · 2013-10-13T23:42:13Z

@JanSchulz can you rebase and squash?

jankatins · 2013-10-14T17:48:23Z

@jreback done (hopefully...)

jorisvandenbossche · 2013-10-14T17:52:26Z

@JanSchulz Did you rebase? Because it seems that your commit on api.rst has not included the changes of eg #5208 (although I don't think it would conflict)

jreback · 2013-10-14T17:53:15Z

can you add the indexeras (iat/iloc/loc...etc) to Panel as well?

jankatins · 2013-10-14T18:29:42Z

Not sure why it didn't pick up the new changes, but this seems to include them.

jankatins · 2013-10-14T18:34:03Z

@jtratner What do you want for the rest of the documentation? As I understood the docs, the rest does not have links to the API documentation (see e.g. http://pandas.pydata.org/pandas-docs/dev/groupby.html)

jreback · 2013-10-14T18:48:29Z

@JanSchulz this looks fine....

should we include __getitem__? (get you wouldn't really search on that though...?)

and not sure we actually have explicitydocs on it

jreback · 2013-10-15T14:21:10Z

@JanSchulz this looks fine

@jorisvandenbossche @jtratner merge?

jorisvandenbossche · 2013-10-15T14:36:26Z

@jreback certainly fine!
But I think it has to be rebased again .. (because of my last PR that got merged yesterday, which also touched api.rst, I don't know how smart git is when it are not the same lines that changed).

jankatins · 2013-10-15T17:29:33Z

@jreback @jorisvandenbossche rebased and removed some trailing whitespace

jreback · 2013-10-15T17:39:57Z

@jorisvandenbossche pls give a once over..looks mergeable to me

jorisvandenbossche · 2013-10-15T18:35:24Z

@jreback good to merge!

Add indexer and str to API documentation

jtratner reviewed Oct 6, 2013
View reviewed changes

jorisvandenbossche reviewed Oct 6, 2013
View reviewed changes

jreback mentioned this pull request Oct 11, 2013

DOC: add DataFrame et al class docstring to api docs #5160

Merged

jankatins added 2 commits October 15, 2013 19:24

Add a convenience function to compile pandas ready for doc-building

fb4e69e

Add some new entries to API doc

ea1a2d5

jreback added a commit that referenced this pull request Oct 15, 2013

Merge pull request #5124 from JanSchulz/API_additions

0aa1800

Add indexer and str to API documentation

jreback merged commit 0aa1800 into pandas-dev:master Oct 15, 2013

jreback mentioned this pull request Oct 15, 2013

API reference for Series.str, DataFrame.{iloc|loc}? #5068

Closed

jankatins mentioned this pull request Feb 2, 2014

From wiki, undocumented public functions #6224

Closed

jorisvandenbossche mentioned this pull request Sep 3, 2014

DOC: {Series,DataFrame}.dot() not listed under API Reference #8163

Closed

jorisvandenbossche mentioned this pull request Dec 29, 2014

DOC: missing apt.rst links #9165

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add indexer and str to API documentation #5124

Add indexer and str to API documentation #5124

jankatins commented Oct 6, 2013

jtratner Oct 6, 2013

jankatins Oct 6, 2013

jtratner Oct 6, 2013

jankatins Oct 6, 2013

jtratner Oct 6, 2013

jtratner commented Oct 6, 2013

jtratner commented Oct 6, 2013

jankatins commented Oct 6, 2013

jtratner commented Oct 6, 2013

jorisvandenbossche Oct 6, 2013

jtratner Oct 6, 2013

jorisvandenbossche commented Oct 6, 2013

jreback commented Oct 7, 2013

jankatins commented Oct 7, 2013

jreback commented Oct 7, 2013

jankatins commented Oct 7, 2013

jankatins commented Oct 7, 2013

jtratner commented Oct 7, 2013

jankatins commented Oct 7, 2013

jtratner commented Oct 7, 2013

jorisvandenbossche commented Oct 8, 2013

jreback commented Oct 11, 2013

jreback commented Oct 13, 2013

jankatins commented Oct 14, 2013

jorisvandenbossche commented Oct 14, 2013

jreback commented Oct 14, 2013

jankatins commented Oct 14, 2013

jankatins commented Oct 14, 2013

jreback commented Oct 14, 2013

jreback commented Oct 15, 2013

jorisvandenbossche commented Oct 15, 2013

jankatins commented Oct 15, 2013

jreback commented Oct 15, 2013

jorisvandenbossche commented Oct 15, 2013

Add indexer and str to API documentation #5124

Add indexer and str to API documentation #5124

Conversation

jankatins commented Oct 6, 2013

jtratner Oct 6, 2013

Choose a reason for hiding this comment

jankatins Oct 6, 2013

Choose a reason for hiding this comment

jtratner Oct 6, 2013

Choose a reason for hiding this comment

jankatins Oct 6, 2013

Choose a reason for hiding this comment

jtratner Oct 6, 2013

Choose a reason for hiding this comment

jtratner commented Oct 6, 2013

jtratner commented Oct 6, 2013

jankatins commented Oct 6, 2013

jtratner commented Oct 6, 2013

jorisvandenbossche Oct 6, 2013

Choose a reason for hiding this comment

jtratner Oct 6, 2013

Choose a reason for hiding this comment

jorisvandenbossche commented Oct 6, 2013

jreback commented Oct 7, 2013

jankatins commented Oct 7, 2013

jreback commented Oct 7, 2013

jankatins commented Oct 7, 2013

jankatins commented Oct 7, 2013

jtratner commented Oct 7, 2013

jankatins commented Oct 7, 2013

jtratner commented Oct 7, 2013

jorisvandenbossche commented Oct 8, 2013

jreback commented Oct 11, 2013

jreback commented Oct 13, 2013

jankatins commented Oct 14, 2013

jorisvandenbossche commented Oct 14, 2013

jreback commented Oct 14, 2013

jankatins commented Oct 14, 2013

jankatins commented Oct 14, 2013

jreback commented Oct 14, 2013

jreback commented Oct 15, 2013

jorisvandenbossche commented Oct 15, 2013

jankatins commented Oct 15, 2013

jreback commented Oct 15, 2013

jorisvandenbossche commented Oct 15, 2013